The build command tells the tool to open the repository. It open the repository defined in the path to repository parameter. The command line to build a repository is as follows:
ReqAdmin build [-v] [-req] [-skipupdate] <Path to repository> <Output path>
| Argument | Definition |
|---|---|
| --repositorypath | Required. The path to the repository. |
| --outputpath | Required. The path where the build output will be written. Specify a path different than the repository path. |
| --skipupdate | (Default: false) Flag indicating whether to skip the update content references process. If the argument is not passed, content references in the target repository are updated before it is built. The skip update switch is typically used when you have recently performed an update to content references using the update command just prior to building a content repository (using the build command). In this case, you are confident that the content references have been updated and are not out of date. See Updating Content References in Dynamic Documents for details. |
| --nocopytochildorgs | (Default: false) Flag indicationg whether to copy base content to child orgs as a prebuild step when building repositories with precedence strucuture. |
| --sourceschemasinorganization | (Default: false) Flag indicationg whether schemas are copied to each oranization. They are only in the repository folder by default. |
| --nogenerateschemafiles | (Default: false) Flag indicationg to not generate document data requirements as schema for each document. This value is false by default. |
| --generatexpathdatalistfiles | (Default: false) Flag indicationg to generate document data requirements as data lists for each document. This value is false by default. |
| --reqformat | (Default: false) Flag indicating to build in REQ format not ERL. This value is false by default. |
| -v | (Default: false) Flag indicating to log verbose messages to the console. This value is false by default. |
| --help | Display this help screen. |
| --version | Display version information. |
- The build command updates content references from the content in the file system repository that is being built; this differs from behavior in the Requirements Editor where content reference updates are performed through the authoring web service and database.
- All Manifest and JS files are included in the repository after the build output.
- Javascript unit tests are run when the ContentAdmin build is run.
- Any errors in the unit tests are logged in the bottom of the build output report as warnings.
- Tests are performed on all standard and customized repositories using either the command line or the user interface.
The output is then placed at the path location entered in the second path parameter: <Output path>. The directory output layout, as required by the load command, is as follows:
<output root> - Organization 1 name -REQ or ERL files - Organization 2 name -REQ or ERL files - Organizations.xml - BuildReport.html - BuildReport.xml - DocumentRevisionHistory.csv
Both the BuildReport.html and BuildReport.xml files contain the results of the build and detail any REQ files that failed to build. These two files contain identical information, only in different formats: one in xml and one in html (recommended for viewing). The DocumentRevisionHistory.csv file contains the cumulative revision history of all the REQ files that were built.
HTML Developers Guide
Each time a repository is built, an HTML Developers Guide is created using the various TypeScript and Javascript files.
The files are placed within a folder under the build location, as follows:
When there are multiple TypeScript or Javascript files, multiple reports are generated.
The report can be viewed by double-clicking the .html file in the report folder. The report, similar to the following is displayed.
